home *** CD-ROM | disk | FTP | other *** search
/ Aminet 24 / Aminet 24 (1998)(GTI - Schatztruhe)[!][Apr 1998].iso / Aminet / dev / misc / Revisor.readme < prev    next >
Text File  |  1998-03-07  |  9KB  |  329 lines
  1. Short:    Revisor V1.0  Version and revision bump utility.
  2. Author:   cscholling@t-online.de (Carsten Scholling)
  3. Uploader: cscholling@t-online.de (Carsten Scholling)
  4. Version:  1.0
  5. Type:     dev/misc
  6. Requires: OS2.x
  7.  
  8.  
  9.  
  10. Description:
  11. ¯¯¯¯¯¯¯¯¯¯¯
  12. Revisor  is  a  util for creating version/revision files for C and ASM.  It also
  13. allows  easy version and revision bumping.  And Revisor uses NO "brain"-files to
  14. store  it's information, because all needed information for bumping is read from
  15. the revision files itself.
  16.  
  17. I  use  it  for  all  my  programs without any problems for now four month and i
  18. decided to bump it's version to 1 and release it to the masses.  ;-)
  19.  
  20.  
  21.  
  22. Usage:
  23. ¯¯¯¯¯
  24. Command line template follows:
  25.  
  26. Revisor  PRG=PRGNAME,PRO=PROJECTNAME/K,VER=VERSION/N/K,REV=REVISION/N/K,
  27.          BETA/N/K,PROVER=PROJECTVERSION/N/K,PROREV=PROJECTREVISION/N/K,
  28.          DESC=DESCRIPTION/K,AUT=AUTHOR/K,COPY=COPYRIGHT/K,C/S,ASM/S,
  29.          CPPC=CPPCOMMENT/S,NOCPPC=NOCPPCOMMENT/S,BV=BUMPVER/S,BR=BUMPREV/S,
  30.          BB=BUMPBETA/S,BPV=BUMPPROJECTVER/S,BPR=BUMPPROJECTREV/S:
  31.  
  32.  
  33. Yes,  i  know  that  this is a complex bulk of parameters, but it's very easy to
  34. handle.   The first time you create your revision file, you have to give most of
  35. the  names parameters to Revisor.  The second and all other times, you only have
  36. to  give  the  sections  you  want  to  update  or  to bump.  Let me explain the
  37. parameters:
  38.  
  39.  
  40.                  PRG=PRGNAME  - Here you must specify the program name for which
  41.                                 you want to create a revision file. You must not
  42.                                 add   any   extensions   like   ".c"  or ".h" or
  43.                                 something.
  44.  
  45.            PRO=PROJECTNAME/K  - After this  keyword you  give a  project name if
  46.                                 your program is not stand alone for example.
  47.  
  48.              VER=VERSION/N/K  - The ordinary version of your program.
  49.  
  50.             REV=REVISION/N/K  - Same for the revision parameter.
  51.  
  52.                     BETA/N/K  - Here you specify the beta version if one.
  53.  
  54.    PROVER=PROJECTVERSION/N/K  - This belongs to the project and is it's version.
  55.  
  56.   PROREV=PROJECTREVISION/N/K  - Belongs to the project too: Project revision.
  57.  
  58.           DESC=DESCRIPTION/K  - Here you  can give a short  description of  what
  59.                                 your program is for.
  60.  
  61.                 AUT=AUTHOR/K  - This is your name (in most cases).
  62.  
  63.             COPY=COPYRIGHT/K  - This is the copyright information.
  64.  
  65.                          C/S  - Use  this  switch  if  you  want  to create  a C
  66.                                 revision file.  The given PRGNAME parameter plus
  67.                                 "_rev.h" is the name of your revision file. This
  68.                                 is only for creation  time or if you want to add
  69.                                 a C revision file to your app.
  70.  
  71.                        ASM/S  - The switch for an  ASM file.  Same as above, but
  72.                                 the name is PRGNAME plus  "_rev.i".
  73.  
  74.            CPPC=CPPCOMMENT/S  - This tells Revisor to use C++ comment lines.
  75.  
  76.        NOCPPC=NOCPPCOMMENT/S  - Tells  Revisor to  NOT use  C++  comments.  Only
  77.                                 usefull if you  want to change you  existing C++
  78.                                 file to normal C-style.
  79.  
  80.  
  81.                 BV=BUMPVER/S  - With  this  switch,  you  bump  up your  program
  82.                                 version by 1 (from 2 to 3 for example)
  83.  
  84.                 BR=BUMPREV/S  - Same here, but for the revision.
  85.  
  86.                BB=BUMPBETA/S  - This bumps up your beta information by 1.
  87.  
  88.         BPV=BUMPPROJECTVER/S  - Again the  same as  above,  but for your overall
  89.                                 project version number.
  90.  
  91.         BPR=BUMPPROJECTREV/S  - And  again  the  same as  above  for the project
  92.                                 revision.
  93.  
  94.  
  95. That's all folks!
  96.  
  97.  
  98.  
  99. Example use:
  100. ¯¯¯¯¯¯¯¯¯¯¯
  101. Let's  say  your  application  name  is  "App"  and  belongs to a project called
  102. "Project".  The current application state is version 1, revision 2 and your beta
  103. state  is  3.   For your whole project, the state is V1.1.  Because your program
  104. consist  of  C  and  ASM  files you need both, C and ASM revision files.  And at
  105. last,  you  want  to  use  C++ comments in the C revision file, because they are
  106. nicer.
  107.  
  108. For  creating  a  fully new revision file for your application use the following
  109. (sure, that you have to specify all parameters in one line ;-):
  110.  
  111.  
  112.     Revisor  App  PROJECTNAME       "Project"
  113.                   VERSION           1
  114.                   REVISION          2
  115.                   BETA              3
  116.                   PROJECTVERSION    1
  117.                   PROJECTREVISION   1
  118.                   DESCRIPTION       "My favorite application."
  119.                   AUTHOR            "your name"
  120.                   COPYRIGHT         "Copyright ©1998"
  121.                   C
  122.                   ASM
  123.                   CPPCOMMENT
  124.  
  125.  
  126. The resulting revision files look like this:
  127.  
  128. --------------------------------------------------------------------------------
  129.  
  130. // #############################################################################
  131. // ###
  132. // ###    App_rev.h    -    built automatically by Revisor 1.0
  133. // ###
  134. // ###
  135. // ###            Revisor        Copyright ©1998 by Carsten Scholling
  136. // ###                        All rights reserved.
  137. // ###
  138. // ###
  139. // ###        DO NOT EDIT BY HAND!!!
  140. // ###
  141. // #############################################################################
  142. #ifndef    APP_REV_H
  143. #define    APP_REV_H
  144.  
  145.  
  146. #include    <libraries/iffparse.h>
  147.  
  148.  
  149. #define    PROJECT_ID            MAKE_ID('P','R','O','J')
  150.  
  151. #define    PROJECTNAME            "Project"
  152. #define    NAME                "App"
  153. #define    DESCRIPTION            "My favorite application."
  154. #define    FULLNAME            "App - My favorite application."
  155. #define    AUTHOR                "your name"
  156. #define    COPYRIGHT            "Copyright ©1998"
  157.  
  158. #define    PROJECTVERSION        1
  159. #define    PROJECTREVISION        1
  160. #define    VERSION                1
  161. #define    REVISION            2
  162. #define    BETAVERSION            3
  163.  
  164. #define    DATE                "24.02.98"
  165. #define    TIME                "19:41:06"
  166. #define    DAY                    "Dienstag"
  167.  
  168. #define    VERSION_STRING        "1.2ß3"
  169. #define    FULLVERSION_STRING    "1.2ß3 (24.02.98)"
  170.  
  171. #define    VERS                "App 1.2ß3"
  172. #define    VSTRING                "App 1.2ß3 (24.02.98)\r\n"
  173. #define    VERSTAG                "\0$VER: App 1.2ß3 (24.02.98)"
  174.  
  175. #define    CATALOG_NAME        "app.catalog"
  176. #define    CATALOG_VERSION        1
  177.  
  178. #endif    // APP_REV_H
  179.  
  180. --------------------------------------------------------------------------------
  181.  
  182. ******************************************************************************
  183. *
  184. *    App_rev.i    -    built automatically by Revisor 1.0
  185. *
  186. *
  187. *            Revisor        Copyright ©1998 by Carsten Scholling
  188. *                        All rights reserved.
  189. *
  190. *    
  191. *        DO NOT EDIT BY HAND!!!
  192. *
  193. ******************************************************************************
  194.  
  195.  
  196. PROJECTNAME            MACRO
  197.                     dc.b    'Project'
  198.                     ENDM
  199.  
  200. NAME                MACRO
  201.                     dc.b    'App'
  202.                     ENDM
  203.  
  204. DESCRIPTION            MACRO
  205.                     dc.b    'My favorite application.'
  206.                     ENDM
  207.  
  208. FULLNAME            MACRO
  209.                     dc.b    'App - My favorite application.'
  210.                     ENDM
  211.  
  212. AUTHOR                MACRO
  213.                     dc.b    'your name'
  214.                     ENDM
  215.  
  216. COPYRIGHT            MACRO
  217.                     dc.b    'Copyright ©1998'
  218.                     ENDM
  219.  
  220. PROJECTVERSION        EQU        1
  221. PROJECTREVISION        EQU        1
  222. VERSION                EQU        1
  223. REVISION            EQU        2
  224. BETAVERSION            EQU     3
  225.  
  226. DATE                MACRO
  227.                     dc.b    '24.02.98'
  228.                     ENDM
  229.  
  230. TIME                MACRO
  231.                     dc.b    '19:41:06'
  232.                     ENDM
  233.  
  234. DAY                    MACRO
  235.                     dc.b    'Dienstag'
  236.                     ENDM
  237.  
  238. VERSION_STRING        MACRO
  239.                     dc.b    '1.2ß3'
  240.                     ENDM
  241.  
  242. FULLVERSION_STRING    MACRO
  243.                     dc.b    '1.2ß3 (24.02.98)'
  244.                     ENDM
  245.  
  246. VERS                MACRO
  247.                     dc.b    'App 1.2ß3'
  248.                     ENDM
  249.  
  250. VSTRING                MACRO
  251.                     dc.b    'App 1.2ß3 (24.02.98)',13,10,0
  252.                     ENDM
  253.  
  254. VERSTAG                MACRO
  255.                     dc.b    0,'$VER: App 1.2ß3 (24.02.98)',0
  256.                     ENDM
  257.  
  258. CATALOG_NAME        MACRO
  259.                     dc.b    'app.catalog'
  260.                     ENDM
  261.  
  262. CATALOG_VERSION        EQU        1
  263.  
  264. --------------------------------------------------------------------------------
  265.  
  266.  
  267. So.   The  time runs away and your application is out of the beta state and it's
  268. time  to  release your stuff.  So you have to reset the beta version to 0.  This
  269. is done by:
  270.  
  271.     Revisor  App  RESETBETA
  272.  
  273. or
  274.  
  275.     Revisor  App  BETA 0
  276.  
  277.  
  278.  
  279. Two  month later (you have forgotten to increase the revision meanwhile ;-), you
  280. want to release the next version V1.3. Simply type:
  281.  
  282.     Revisor  App  BUMPREV
  283.  
  284.  
  285.  
  286. If   you   only   want   to